Angular: update wrong type for webpackStatsJson in start-storybook schema.json #24494
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valentinpalkovic
approved these changes
Oct 17, 2023
valentinpalkovic
approved these changes
Oct 18, 2023
valentinpalkovic
changed the title
11 tasks
|
Came here to say that our e2e tests failed due to that! And it was already fixed!!! Magic <3 <3 <3 |
|
@mandarini In case you are also using nx: I've found a workaround until the new storybook version is released, you can adapt your {
"name": "storybook",
"$schema": "../node_modules/nx/schemas/project-schema.json",
// ...
"targets": {
"serve": {
// ...
"options": {
// ...
"webpackStatsJson": "" // 👈 workaround, has the same effect as false but does not trigger type error
}
}
}
} |
4 tasks
valentinpalkovic
added
the
patch:yes
storybook-bot
pushed a commit
that referenced
this pull request
Oct 19, 2023
Angular: update wrong type for webpackStatsJson in start-storybook schema.json (cherry picked from commit a5a7747)
Merged
5 tasks
|
Thank you!!!! |
github-actions
bot
added
the
patch:done
|
Thank you @valentinpalkovic for the fast merge and patch version release 🎉 |
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #24512
What I did
In Storybook 7.5.0, the schema for
start-storybookhas a wrong type set for thewebpackStatsJsonproperty.Either the type needs to be adapted or the default value should be changed / removed.
I went with changing the type, as...:
["boolean", "string"]type is also specified in the scheme forbuild-storybook:https://github.com/storybookjs/storybook/blob/next/code/frameworks/angular/src/builders/build-storybook/schema.json#L65
string | booleantype is also defined in theCLIOptionsinterface insidecore-common.ts:https://github.com/storybookjs/storybook/blob/next/code/lib/types/src/modules/core-common.ts#L160
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Not covered by automated tests as far as I can tell
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
To be honest I'm not sure how to test this isolated... When starting storybook trough the CLI I can't reproduce this error, it only occurs for me when starting storybook via nx.(Taken from the PR which introduced the property into the scheme: #24388)
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>